home *** CD-ROM | disk | FTP | other *** search
/ Aminet 2 / Aminet AMIGA CDROM (1994)(Walnut Creek)[Feb 1994][W.O. 44790-1].iso / Aminet / util / gnu / groff_src.lha / Groff-1.07 / README.amiga < prev    next >
Text File  |  1993-04-09  |  7KB  |  185 lines
  1. Short: groff-1.07 (src+bin) 2.x probably required
  2.  
  3. This is GNU groff-1.07 for the Amiga. I have heard you can run
  4. this on KS1.3, but the behaviour is flaky. This is because
  5. ixemul.library is increasingly more suited for 2.x systems
  6. and not 1.x systems. Please don't expect much in the way
  7. of bug fixes if you find a problem under 1.x. My suggestion
  8. is that you upgrade to 2.x, it is much nicer anyway!
  9.  
  10. ------------------------------------------------------------------------------
  11.  
  12. INSTALLING GROFF
  13.  
  14. Pre-requisites (optional?):
  15.  
  16. 1. PD ksh (pdksh.lha) can be found on aminet. Get it! You
  17.    need it to run the Bourne shell scripts which are distributed
  18.    with groff.
  19.  
  20. To install:
  21.  
  22. 1. Copy Amiga/libs/ixemul.library to sys:libs
  23.    See Amiga/libs/COPYING.LIB for information on
  24.    the distributability of this library. You can skip this
  25.    step if you already have a version of ixemul.library. Just
  26.    be sure it is version 39.45 or higher.
  27.  
  28. 2. Assign etc: somewhere (anywhere). Sorry, but this is
  29.    a requirement of ixemul.library, not groff.
  30.  
  31. 3. Put the directories Amiga/usr/lib, Amiga/usr/bin and
  32.    Amiga/usr/man in usr:lib, usr:bin, and usr:man respectively. 
  33.    This means you must assign a directory usr: to some place
  34.    on your system. This is the easiest way to do it. 
  35.  
  36.            -OR-
  37.  
  38.    Put the directory Amiga/usr/lib/groff/font anywhere you like
  39.    and set the environment variable GROFF_FONT_PATH to point
  40.    to that directory path. 
  41.  
  42.    Put the directory Amiga/usr/lib/groff/tmac anywhere you like 
  43.    and set the environment variable GROFF_TMAC_PATH to point
  44.    to that directory path.
  45.  
  46.    Put the files in Amiga/usr/bin/ somewhere in your path
  47.    where they can be executed by you (and by groff).
  48.  
  49.    Put the directory Amiga/usr/man anywhere you like and configure
  50.    for your man command (if you have one). You can run groff
  51.    on these files to display them too! 
  52.  
  53.    The file Amiga/usr/lib/groff/eign is the only orphan. 
  54.    If you use indxbib, create a usr:lib/groff/eign pathname 
  55.    for just this one file. Sorry, there is no way to change
  56.    this without recompiling groff (specifically indxbib).
  57.  
  58. 4. Assign tmp: to some directory where scratch files can
  59.    be created.
  60.  
  61.         -OR-
  62.  
  63.    You can set the environment variable GROFF_TMPDIR to some 
  64.    directory name where scratch files can be created.
  65.  
  66. 5. Set your stack to a large value (e.g. 200000). You can
  67.    try smaller values. I have had good success with 32768
  68.    as my stack size (running groff from within pdksh). Smaller
  69.    values may work too, but the first thing to change if groff fails
  70.    is the stack size (make it bigger!).
  71.    
  72. Once you have done these steps, you are ready to run groff. You
  73. can optionally set the environment variable GROFF_TYPESETTER to
  74. your default typesetter (ps, latin1, ascii, ...). This is
  75. a shortcut for the -T switch on the command line.
  76.  
  77. Try these command lines (first one depends on pdksh being installed):
  78.  
  79.     sh usr:bin/gnroff -Tascii -man usr:man/man1/groff.1
  80.  
  81. or this for postscript output:
  82.  
  83.     gtroff -man usr:man/man1/groff.1
  84.  
  85.  
  86. Please refer to the Amiga/usr/man/man1/groff.1 man page for information
  87. about the various environment variables and how they are used. Browse
  88. all the documentation in Amiga/usr/man/man1 for information about
  89. other groff related commands and post processors.
  90.  
  91. ------------------------------------------------------------------------------
  92.  
  93. TROUBLESHOOTING:
  94.  
  95.     Problem: Groff guru's the machine or causes a software failure forcing
  96.              reboot.
  97.  
  98.     Solutions:
  99.  
  100.         1. Try setting stack to a higher value. 
  101.         2. Are you running 2.x AmigaDOS/Kickstart?
  102.         3. Do you have enough free RAM?
  103.  
  104.     Problem: ixemul.library requester for etc: appears
  105.  
  106.     Solutions:
  107.  
  108.         1. Assign etc: to anywhere (e.g. ram:).
  109.  
  110.     Problem: groff (as opposed to gtroff or gnroff) is failing.
  111.  
  112.     Solutions:
  113.  
  114.         1. Try the equivalent gtroff command line. If you are
  115.            running 1.3, ixemul.library could be causing problems
  116.            for you.
  117.         2. Try the solutions listed above for software failure/guru.
  118.  
  119.  
  120.     Refer to the man pages and the file PROBLEMS for more generic
  121.     problems and solutions. 
  122.  
  123. ------------------------------------------------------------------------------
  124.  
  125. BUILDING GROFF
  126.  
  127. This is non-trivial! You will need lots of stuff to get this going.
  128. You will need pdksh, rm, cat, tr, awk, c++ compiler (g++), and a
  129. make command as flexible as gmake. You will need lots of RAM. I
  130. have 9MB on my system and it is barely enough for some of the
  131. steps need to build groff. 
  132.  
  133. I used parts of GNU fileutils, GNU shellutils, BSD tr,
  134. GNU grep, GNU fgrep, GNU elvis, GNU awk, pdksh, SKsh-2.1 and 
  135. GNU gcc to build groff. I also patched my version of pdksh to 
  136. automatically source /etc/profile (i.e. etc:profile) every time 
  137. it is invoked.  This solves a lot of problems you would have otherwise.
  138.  
  139. I provided the patched versions of a handful of files in the
  140. groff distribution (mdate.sh, groff-test), the configure.amiga 
  141. script (adapted from configure), and the Makefile generated by configure.
  142. You will need to customize mdate.sh to your version of ls (I am
  143. using GNU fileutils ls).
  144.  
  145. Many thanks to Markus Wild and his excellent ports of GCC 2.2.2
  146. and PDksh. Without those programs and ixemul.library, none 
  147. of this would be possible. Thank you Markus!
  148.  
  149. To configure groff the way you want (you fill in <some path>):
  150.  
  151.     sh configure.amiga --prefix=<some path>
  152.  
  153. To build groff with gmake:
  154.  
  155.     gmake all
  156.     gmake install
  157.  
  158. My configuration (if it matters):
  159.  
  160. A500 (CSA MMR MC68030/25 acclerator + 68882 math co-pro)
  161. 8MB fast RAM (4MB 32-bit, 4MB 16-bit)
  162. 1MB chip RAM
  163. GVP Series II with 40MB and 105MB hard disks.
  164.  
  165. ------------------------------------------------------------------------------
  166.  
  167. Please feel free to contact me for help with this package. I regularly
  168. read comp.sys.amiga.applications, comp.sys.amiga.misc, and 
  169. comp.sys.amiga.programmer. You can also e-mail me directly at the address
  170. listed below. 
  171.  
  172. Before you contact me, please read the documentation in this distribution first!
  173. I don't know how many times I answered questions for groff-1.06 where the answer 
  174. was 'increase your stack size'. I am glad to help with any bugs you might
  175. find, especially if they relate to the Amiga. Groff specific problems should
  176. be reported as indicated in the file BUG-REPORTS.
  177.  
  178. Cheers!
  179.  
  180. Rob Tulloh (robtu@itx.isc.com)
  181. INTERACTIVE / SHL Systemhouse     Tel: (512) 343 0376 Ext. 116
  182. 9442 Capital of Texas Hwy. North  Fax: (512) 343 1414
  183. Arboretum Plaza One, Suite 700    Net: robtu@itx.isc.com (soon to be robtu@aus.shl.com)
  184. Austin, Texas 78759             
  185.